Skip to content

docs: add GitHub Issue templates for bug reports and feature requests#237

Merged
mrizzi merged 2 commits into
mainfrom
TC-5081
Jul 7, 2026
Merged

docs: add GitHub Issue templates for bug reports and feature requests#237
mrizzi merged 2 commits into
mainfrom
TC-5081

Conversation

@mrizzi

@mrizzi mrizzi commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

  • Add bug report template at .github/ISSUE_TEMPLATE/bug-report.md with required fields: description, steps to reproduce, expected/actual behavior, plugin version, Claude Code version
  • Add feature request template at .github/ISSUE_TEMPLATE/feature-request.md with problem statement and optional solution/alternatives fields
  • Both templates include a triage note that issues are reviewed by maintainers and may be promoted to Jira for planning
  • Convert markdown templates to YAML-based GitHub issue forms (.yml) to enforce required fields at the UI level, with separate structured fields for OS, shell, and MCP server configuration

Preview

Implements TC-5081, TC-5097

@mrizzi
docs: add GitHub Issue templates for bug reports and feature requests
7e40c38 
Add structured issue templates so external contributors can report bugs
and propose features through GitHub Issues. Both templates include a
triage note explaining that issues may be promoted to Jira for planning.

Implements TC-5081

Assisted-by: Claude Code
@sourcery-ai

sourcery-ai Bot commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds structured GitHub issue templates for bug reports and feature requests, standardizing the information collected from users and including a maintainer triage note.

File-Level Changes

Change Details Files
Introduce a structured bug report issue template to standardize diagnostic information.
  • Create a Bug Report issue template with frontmatter configuring name, description, labels, and assignees.
  • Define sections for description, steps to reproduce, expected behavior, actual behavior, plugin version, Claude Code version, and additional context.
  • Add guidance text for each section to encourage detailed and actionable reports.
  • Include a triage note explaining that issues are reviewed by maintainers and may be promoted to Jira for planning.
 .github/ISSUE_TEMPLATE/bug-report.md
Introduce a structured feature request issue template to clarify user needs and proposals.
  • Create a Feature Request issue template with frontmatter configuring name, description, labels, and assignees.
  • Define sections for problem statement, proposed solution, alternatives considered, and additional context, marking some fields as optional.
  • Add descriptive helper text to focus on the problem and clearly describe potential solutions or alternatives.
  • Include a triage note explaining that issues are reviewed by maintainers and may be promoted to Jira for planning.
 .github/ISSUE_TEMPLATE/feature-request.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai Bot reviewed Jul 7, 2026
View reviewed changes

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider converting these markdown templates to GitHub issue forms (YAML-based) so key fields like versions and reproduction steps can be required and consistently structured for triage.
  • In the bug report template, you might want to break out environment details (OS, shell, MCP server configuration) into explicit bullet points instead of a free-form 'Additional Context' section to encourage more consistent reporting.
Prompt for AI Agents 
Please address the comments from this code review:

## Overall Comments
- Consider converting these markdown templates to GitHub issue forms (YAML-based) so key fields like versions and reproduction steps can be required and consistently structured for triage.
- In the bug report template, you might want to break out environment details (OS, shell, MCP server configuration) into explicit bullet points instead of a free-form 'Additional Context' section to encourage more consistent reporting.
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mrizzi

mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

[sdlc-workflow/verify-pr] Re: @sourcery-ai[bot] review —

  1. "Convert markdown templates to GitHub issue forms (YAML-based)": Classified as suggestion — this proposes an alternative format (YAML forms) that is not documented in CONVENTIONS.md and has no established codebase pattern (these are the first issue templates in the repository). No sub-task created.

  2. "Break out environment details into explicit bullet points": Classified as suggestion — this proposes a structural improvement to template content that is not tied to any documented convention. No sub-task created.

@mrizzi

mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

Verification Report for TC-5081 (commit 7e40c38)

Check Result Details
Review Feedback PASS 2 suggestions from sourcery-ai[bot], no code change requests
Root-Cause Investigation N/A No sub-tasks created
Scope Containment PASS PR files match task specification exactly (2/2 files)
Diff Size PASS 66 additions across 2 new files, proportionate to task
Commit Traceability PASS 1/1 commits reference TC-5081
Sensitive Patterns PASS No secrets or credentials detected
CI Status PASS All 3 checks passed (Plugin Validation, Skill Lint, Sourcery)
Acceptance Criteria PASS 6 of 6 criteria met
Test Quality N/A No test files in PR; Eval Quality: N/A
Test Change Classification N/A No test files in PR
Verification Commands N/A No verification commands specified

Overall: PASS

All checks passed. Templates are correctly structured with valid GitHub issue template front matter, all required fields present, and triage notes included.

This comment was AI-generated by sdlc-workflow/verify-pr v0.12.2.

@mrizzi
docs: convert issue templates from markdown to YAML-based issue forms
a2e1365 
Replace markdown issue templates with GitHub issue forms (.yml) to enforce
required fields at the UI level. Bug report now has separate structured
fields for OS, shell, and MCP server configuration instead of free-form
Additional Context. Both forms include the triage note in the top-level
description.

Implements TC-5097

Assisted-by: Claude Code
@mrizzi

mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

Verification Report for TC-5081 (commit a2e1365)

Check Result Details
Review Feedback PASS 2 suggestions (already-classified, implemented via TC-5097)
Root-Cause Investigation N/A No sub-tasks created
Scope Containment PASS .yml files justified by sub-task TC-5097 converting .md to YAML forms
Diff Size PASS 114 additions across 2 files, proportionate
Commit Traceability PASS 2/2 commits reference valid task IDs (TC-5081, TC-5097)
Sensitive Patterns PASS No secrets or credentials detected
CI Status PASS All 3 checks passed (Plugin Validation, Skill Lint, Sourcery)
Acceptance Criteria PASS 6 of 6 criteria met (.yml equivalents satisfy .md criteria)
Test Quality N/A No test files in PR; Eval Quality: N/A
Test Change Classification N/A No test files in PR
Verification Commands N/A No verification commands specified

Overall: PASS

All checks passed. Both sourcery-ai suggestions from the initial review have been implemented via sub-task TC-5097: templates converted to YAML-based issue forms with enforced required fields and structured environment fields.

This comment was AI-generated by sdlc-workflow/verify-pr v0.12.2.

@mrizzi mrizzi merged commit 20723a1 into main Jul 7, 2026
3 checks passed
@mrizzi mrizzi deleted the TC-5081 branch July 7, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mrizzi